<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
  <meta charset="utf-8" />
  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  <title>Pytket User Manual &mdash; pytket-manual  documentation</title>
      <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
      <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
      <link rel="stylesheet" href="_static/jupyter-sphinx.css" type="text/css" />
      <link rel="stylesheet" href="_static/thebelab.css" type="text/css" />
  <!--[if lt IE 9]>
    <script src="_static/js/html5shiv.min.js"></script>
  <![endif]-->
  
        <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
        <script src="_static/jquery.js"></script>
        <script src="_static/underscore.js"></script>
        <script src="_static/doctools.js"></script>
        <script src="_static/thebelab-helper.js"></script>
        <script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
        <script src="https://unpkg.com/@jupyter-widgets/html-manager@^0.20.0/dist/embed-amd.js"></script>
    <script src="_static/js/theme.js"></script>
    <link rel="index" title="Index" href="genindex.html" />
    <link rel="search" title="Search" href="search.html" />
    <link rel="next" title="What is tket?" href="manual_intro.html" /> 
</head>

<body class="wy-body-for-nav"> 
  <div class="wy-grid-for-nav">
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search" >
            <a href="#" class="icon icon-home"> pytket-manual
          </a>
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>
        </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
              <ul>
<li class="toctree-l1"><a class="reference internal" href="manual_intro.html">What is tket?</a></li>
<li class="toctree-l1"><a class="reference internal" href="manual_circuit.html">Circuit Construction</a></li>
<li class="toctree-l1"><a class="reference internal" href="manual_backend.html">Running on Backends</a></li>
<li class="toctree-l1"><a class="reference internal" href="manual_compiler.html">Compilation</a></li>
<li class="toctree-l1"><a class="reference internal" href="manual_noise.html">Noise and the Quantum Circuit Model</a></li>
<li class="toctree-l1"><a class="reference internal" href="manual_assertion.html">Assertion</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">More documentation:</span></p>
<ul>
<li class="toctree-l1"><a class="reference external" href="https://cqcl.github.io/tket/pytket/api/index.html">pytket</a></li>
</ul>

        </div>
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
          <a href="#">pytket-manual</a>
      </nav>

      <div class="wy-nav-content">
        <div class="rst-content">
          <div role="navigation" aria-label="Page navigation">
  <ul class="wy-breadcrumbs">
      <li><a href="#" class="icon icon-home"></a> &raquo;</li>
      <li>Pytket User Manual</li>
      <li class="wy-breadcrumbs-aside">
            <a href="_sources/index.rst.txt" rel="nofollow"> View page source</a>
      </li>
  </ul>
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
             
  <div class="section" id="pytket-user-manual">
<h1>Pytket User Manual<a class="headerlink" href="#pytket-user-manual" title="Permalink to this headline"></a></h1>
<p>This manual refers to the following versions of pytket and extensions:</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>pytket == 0.18.0
pytket-cirq == 0.19.0
pytket-honeywell == 0.19.0
pytket-projectq == 0.17.0
pytket-pyquil == 0.19.0
pytket-qiskit == 0.21.0
pytket-qsharp == 0.20.0
pytket-qulacs == 0.15.0
</pre></div>
</div>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="manual_intro.html">What is tket?</a><ul>
<li class="toctree-l2"><a class="reference internal" href="manual_intro.html#nisq-considerations">NISQ Considerations</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual_intro.html#quantum-compilation">Quantum Compilation</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual_intro.html#platform-agnosticism">Platform-Agnosticism</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual_intro.html#installation">Installation</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual_intro.html#how-to-cite">How To Cite</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual_intro.html#support">Support</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="manual_circuit.html">Circuit Construction</a><ul>
<li class="toctree-l2"><a class="reference internal" href="manual_circuit.html#basic-gates">Basic Gates</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual_circuit.html#measurements">Measurements</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual_circuit.html#barriers">Barriers</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual_circuit.html#registers-and-ids">Registers and IDs</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual_circuit.html#composing-circuits">Composing Circuits</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual_circuit.html#boxes">Boxes</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual_circuit.html#analysing-circuits">Analysing Circuits</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual_circuit.html#importing-exporting-circuits">Importing/Exporting Circuits</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual_circuit.html#symbolic-circuits">Symbolic Circuits</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual_circuit.html#advanced-topics">Advanced Topics</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="manual_backend.html">Running on Backends</a><ul>
<li class="toctree-l2"><a class="reference internal" href="manual_backend.html#backend-requirements">Backend Requirements</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual_backend.html#shots-and-sampling">Shots and Sampling</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual_backend.html#statevectors-and-unitaries">Statevectors and Unitaries</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual_backend.html#interpreting-results">Interpreting Results</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual_backend.html#expectation-value-calculations">Expectation Value Calculations</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual_backend.html#guidance-for-writing-hardware-agnostic-code">Guidance for Writing Hardware-Agnostic Code</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual_backend.html#batch-submission">Batch Submission</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual_backend.html#embedding-into-qiskit">Embedding into Qiskit</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual_backend.html#advanced-topics">Advanced Topics</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="manual_compiler.html">Compilation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="manual_compiler.html#predicates">Predicates</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual_compiler.html#rebases">Rebases</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual_compiler.html#placement">Placement</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual_compiler.html#routing">Routing</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual_compiler.html#decomposing-structures">Decomposing Structures</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual_compiler.html#optimisations">Optimisations</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual_compiler.html#combinators">Combinators</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual_compiler.html#predefined-sequences">Predefined Sequences</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual_compiler.html#guidance-for-combining-passes">Guidance for Combining Passes</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual_compiler.html#initial-and-final-maps">Initial and Final Maps</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual_compiler.html#advanced-topics">Advanced Topics</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="manual_noise.html">Noise and the Quantum Circuit Model</a><ul>
<li class="toctree-l2"><a class="reference internal" href="manual_noise.html#noise-aware-mapping">Noise Aware Mapping</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual_noise.html#noise-tailoring-methods">Noise Tailoring Methods</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual_noise.html#spam-mitigation">SPAM Mitigation</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="manual_assertion.html">Assertion</a><ul>
<li class="toctree-l2"><a class="reference internal" href="manual_assertion.html#projector-based">Projector-based</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual_assertion.html#stabiliser-based">Stabiliser-based</a></li>
</ul>
</li>
</ul>
</div>
<div class="toctree-wrapper compound">
<p class="caption" role="heading"><span class="caption-text">More documentation:</span></p>
<ul>
<li class="toctree-l1"><a class="reference external" href="https://cqcl.github.io/tket/pytket/api/index.html">pytket</a></li>
</ul>
</div>
</div>
<div class="section" id="indices-and-tables">
<h1>Indices and Tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline"></a></h1>
<ul class="simple">
<li><p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></p></li>
<li><p><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></p></li>
<li><p><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></p></li>
</ul>
</div>


           </div>
          </div>
          <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
        <a href="manual_intro.html" class="btn btn-neutral float-right" title="What is tket?" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
    </div>

  <hr/>

  <div role="contentinfo">
    <p>&#169; Copyright 2020-2021 Cambridge Quantum Computing Ltd.</p>
  </div>

  Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
    provided by <a href="https://readthedocs.org">Read the Docs</a>.
   

</footer>
        </div>
      </div>
    </section>
  </div>
  <script>
      jQuery(function () {
          SphinxRtdTheme.Navigation.enable(true);
      });
  </script> 

</body>
</html>